Get Employee Maturity Overview

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/data_maturity_scan/employee_maturity_overview \
  --header 'Authorization: Bearer <token>'

{
  "report_name": "employee_data_maturity_overview",
  "report_data": {
    "entity_count": 100,
    "data_maturity_overview": [
      {
        "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
        "low_data_availability": false,
        "reasons": [
          [
            "MAX_SOURCE_GENERALITY",
            "MIN_EVENT_TYPE_DIVERSITY"
          ]
        ]
      }
    ]
  },
  "last_update": "2020-09-01T11:45:49Z"
}

GET

reports

data_maturity_scan

employee_maturity_overview

Get Employee Maturity Overview

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/reports/data_maturity_scan/employee_maturity_overview \
  --header 'Authorization: Bearer <token>'

{
  "report_name": "employee_data_maturity_overview",
  "report_data": {
    "entity_count": 100,
    "data_maturity_overview": [
      {
        "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
        "low_data_availability": false,
        "reasons": [
          [
            "MAX_SOURCE_GENERALITY",
            "MIN_EVENT_TYPE_DIVERSITY"
          ]
        ]
      }
    ]
  },
  "last_update": "2020-09-01T11:45:49Z"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit

integer

default:200

The maximal number of returned entities.

Required range: 1 <= x <= 500

Example:

250

offset

integer

default:0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0

force_recalculate

boolean

default:false

Reports are always stored for a certain time, and if this endpoint is called again within that time, the stored report is returned without recalculating. If force_recalculate is set to true, the report is recalculated and the stored report is overwritten.

update_low_data_availability

boolean

default:true

If enabled, the low_data_availability flag on Employees will be updated according the results of the report.

Example:

true

Response

The base template for a report. The Data Maturity Overview over all Employees.

report_name

string

Name of the report.

Example:

"employee_data_maturity_overview"

report_data

object

Show child attributes

report_data.entity_count

number<integer>

The number of Employees uploaded to the tenant.

Example:

100

report_data.data_maturity_overview

object[]

Data Maturity Overview flags for every Employee if sufficient data is available for qualitative Skill inference. Reasons are listed whenever not enough data is available.

Show child attributes

report_data.data_maturity_overview.external_id

string<uuid>

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

report_data.data_maturity_overview.low_data_availability

boolean

Flag indicating whether sufficient data is available for qualitative Skill inference for a given entity.

Example:

false

report_data.data_maturity_overview.reasons

enum<string>[]

The data issues will result in insufficient data available:

MIN_PROFILE_LENGTH = less than 10 Skills are found in the final Skill Profile.
MIN_SKILL_VOLUME_EVENTS = less than 20 Skills are found across all available Skill Event sources
MAX_SKILL_GENERALITY = more than 40% of all available Skill Event Skills are considered generic, occurring in the final Skill Profile of 25% of all other Jobs.
MAX_SOURCE_GENERALITY = more than 50% of the Skill Event sources are considered generic, mostly based on market data.
MIN_SOURCE_CONFIRMATION = less than 20% average confirmation across all available Skill Event sources.
MIN_EVENT_TYPE_DIVERSITY = less than 3 unique Skill Event sources are available.

Available options:

MIN_PROFILE_LENGTH,

MIN_SKILL_VOLUME_EVENTS,

MAX_SKILL_GENERALITY,

MAX_SOURCE_GENERALITY,

MIN_SOURCE_CONFIRMATION,

MIN_EVENT_TYPE_DIVERSITY

last_update

string<date-time>

Example:

"2020-09-01T11:45:49Z"

Get Job Quality Matrix Get Job Maturity Overview

⌘I

API Documentation

API Versioning

Taxonomy

Employees

Job Families

Jobs

Peer Groups

Vacancies

Courses

Skill Clusters

External Companies

Skills

Organisational Structure

Custom Properties

Matchmaking

Matching Configuration

Export

Reports

Version

Get Employee Maturity Overview

Authorizations

Query Parameters

Response